home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-06 / bt515.exe / BTOOLS / XTRAP.DOC < prev    next >
Text File  |  1991-04-17  |  4KB  |  128 lines
  1.            README FOR XTRAP.EXE : Smart NetWare SQL Trace Utility
  2.  
  3.  
  4. XTRAP.EXE is a TSR that will trap API calls between a front-end application and
  5. NetWare SQL or XQL.  The user may specify specific API functions to trap or
  6. trap them all.  Once trapped, the data may be viewed on the computer display or
  7. written to a log file.  XTRAP will provide an intelligent display of the
  8. parameters specific to the trapped call.  Comments may be added to the log file
  9. at any time from the pop-up menus.
  10.  
  11.  
  12. General Features:
  13.  
  14.   -  Quick display of XTRAP status at any time.
  15.  
  16.   -  Select a Pass Count to pass over API calls.
  17.  
  18. Display Features:
  19.  
  20.   -  Display data before the API call is sent, after the API call returns,
  21.      both, or neither.
  22.  
  23.   -  XTRAP will display each parameter of the API call.  You may select any
  24.      of the parameters and scroll through a memory dump.
  25.  
  26. Log Features:
  27.  
  28.   -  Write to the log file before the API call is sent, after the API call
  29.      returns, both, or neither.
  30.  
  31.   -  Change the log filename at any time. Overwrite or append to an existing
  32.      log file. The default log file name is "xtrap.log".
  33.  
  34.   -  Write a memory dump to the log file before the API call is sent, after
  35.      the API call returns, both, or neither. Two sample log files are included
  36.      with XTRAP:  one with a data memory dump-->"withdump.log", and one
  37.      without-->"nodump.log".
  38.  
  39.   -  Specify the number of memory dump lines to be written to the log file.
  40.  
  41.   -  Specify a maximum size for the log file (start over when size is reached).
  42.      Size = 0 will set file size to "NO LIMIT"
  43.  
  44.   -  Add a comment to the log file at any time.
  45.  
  46. API Selection Features:
  47.  
  48.   -  Trap all of the API calls.
  49.  
  50.   -  Trap None of the API calls.
  51.  
  52.   -  Select specific API calls to trap.
  53.  
  54.   -  Trap unknown API calls (fcn = -1).
  55.  
  56. *******************************************************************************
  57. USAGE:
  58.  
  59. One of the following NetWare SQL Requesters or XQL programs must be loaded
  60. before XTRAP:  NSREQ, NSREQS, XQL, XQLO, XQLP, XQLPO.
  61.  
  62. Load XTRAP with the /r parameter.   (XTRAP /r)
  63.  
  64. Unload XTRAP with the /x parameter.   (XTRAP /x)
  65.  
  66. To activate XTRAP's window display, hit the L-Ctrl, L-Shift, and X keys
  67. simultaneously.
  68.  
  69. Menu options:
  70. -------------
  71. To toggle menu options, type the highlighted letter of the menu option until
  72. the appropriate option is highlighted.  Following is a list of options:
  73.  
  74.  
  75. MAIN MENU:         XTRAP.EXE  NetWare SQL Trace Utility
  76.  
  77.  d: DISPLAY MENU:
  78.  
  79.       d:    eNable or Disable the displaying of trapped API's
  80.       m:    select when to display trapped API
  81.  
  82.  l: LOGGING MENU:
  83.  
  84.       l:    enable or disable all logging
  85.       f:    change the log file name
  86.       m:    select when to log trapped API call
  87.       d:    enable or disable memory dump (only while logging)
  88.       u:    select wheN to log memoRy Dump of trapped API parameters
  89.       n:    enter the Number of memoRy Dump lines for the log file
  90.       s:    enter the maximum size for the log file - after the size
  91.             has been reached it will start the log file over.
  92.                SIZE = 0  --> no size limit.
  93.       c:    add a single line comment to the current log file
  94.  
  95.  s: API SELECTION MENU:
  96.  
  97.       a:    set all API's as "trap"
  98.       n:    set all API's as "do not trap"
  99.       s:    set specific API's as "trap" or "do not trap"
  100.       u:    trap unknown API's (ex. fcn# -1)
  101.  
  102.  p: SET PASS COUNT:   set number of API calls to pass
  103.  
  104.  c: CONFIGURATION FILE: save/load  configuration file (NOT AVAILABLE YET).
  105.  
  106.  
  107.  
  108. NOTE:  If the user tries to create a log file in an area where he or
  109.        she does not have write privileges, the file will not be created
  110.        and the log mode will be set to "Disabled"
  111.  
  112.  
  113.  
  114. ********************************************************************
  115.                           DISCLAIMER
  116.  
  117. Xtrap is provided as is and carries no warranty whatsoever. Novell
  118. disclaims and excludes any and all implied warranties of
  119. merchantability, title and fitness for a particular purpose. Novell
  120. does not warrant that the software will satisfy your requirements
  121. or that the software is without defect or error or that operation of
  122. the software will be uninterrupted. You are using the software at
  123. your risk.  The software is not a product of Novell, Inc. or any
  124. subsidiaries.
  125.  
  126. ********************************************************************
  127.  
  128.